<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Parameter Binding Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">ParamBinding Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Represents an association between an expression and a 
data set or nested report input parameter.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Parameter Binding</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-expression">expression</a></dt>
<dd>An expression used to compute the value of the parameter.</dd>
<dt><a href="#Property-paramName">paramName</a></dt>
<dd>The name of an input parameter in the data set.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>The bindings allow a report item to pass data into its 
data set. For example, a report design may have a customer query from a personal 
database. For each customer, it wants to create a table of open orders from a 
sales database. The bindings allow the inner table item to pass values into the 
input parameters of the inner data set.</p>

<p>A data set parameter binding element that binds a data set input parameter to 
a BIRT expression. See the Binding Input Parameters section in this document for 
how a data set parameter binding is applied in relationship with report 
parameter binding.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Report Item <code>bindings</code> Property</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-expression">expression Property</a></h2>

<p class="section-text">An expression used to compute the value of the parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>any</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Expression</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Provides the value to bind to the input parameter. The 
expression executes in Factory context. The value of the expression must be 
legal for the associated input parameter, or a runtime error may occur. If the 
expression refers to a data row, the row is that of the outer report item (if 
any). No data row is available yet for this report item (because the data set 
has not yet been opened.)</p></div>

<hr>
<h2><a name="Property-paramName">paramName Property</a></h2>

<p class="section-text">The name of an input parameter in the data set.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#name">name</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Parameter Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>This property identifies an input parameter within a data 
set or included report. The name must match a parameter defined in the data set 
or nested report.</p>

<p>The reference name of a data set input parameter and is required. Each data 
set parameter must have at most one binding expression defined within the 
paramBindings property of a data set.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Data Set <code>parameters</code> property</p>
<p>Include element (not in the first release)</p></div>
</body>
</html>
